home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / q2day220.zip / QBBS2DAY.DOC < prev    next >
Text File  |  1990-05-14  |  19KB  |  488 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.           ════════════════════════════════════════════════════
  16.                                 QBBS2DAY
  17.           ════════════════════════════════════════════════════
  18.  
  19.                               Version 2.20
  20.                                 05/14/90
  21.  
  22.  
  23.             The Mailer / BBS System-Usage-Graph Generator
  24.  
  25.                                  for
  26.  
  27.                                QuickBBS
  28.                             Remote Access
  29.                                  OPUS
  30.  
  31.  
  32.                                   by
  33.  
  34.                             Robert Hermans
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.      Copyright (C) 1989-1990 Robert Hermans.  All rights reserved.
  52.  
  53.  
  54.  
  55.  
  56.                                WHAT IS QBBS2DAY ?
  57.                               ────────────────────
  58.  
  59.  
  60.   QBBS2DAY is a professional BBS System - Usage - Graph generator,
  61. just like QuickBBS/RA owns System-usage-graph (menu-type 10), but it is a
  62. lot BETTER, MORE ATTRACTIVE and can do MUCH MORE!  QBBS2DAY can be used
  63. for QuickBBS, RemoteAccess and OPUS.  It combines the internal system-usage
  64. with those from FrontDoor or Binkley (Mailers), so you and your users get a
  65. "real" idea of what's going on in your BBS.
  66.  
  67.   QBBS2DAY started it's way in december of 1989 as an exact clone of QBS
  68. by ...... and it is written using Borland's TURBO Pascal 5.5.
  69.  
  70.  
  71.  
  72.                  DISCLAIMER, LICENSE AND OTHER IMPORTANT STUFF
  73.                  ─────────────────────────────────────────────
  74.  
  75.   The following points must be considered, understood and agreed upon
  76. BEFORE you use QBBS2DAY:
  77.  
  78. * QBBS2DAY is ShareWare, and not FreeWare or Public Domain !
  79.  
  80. * This documentation and the accompanying program is copyrighted material
  81.   by Robert Hermans.
  82.  
  83. * Although care has been taken to write and test a program that does what
  84.   this documentation states, the program is provided as it is, without
  85.   warranty or guarantee of any kind, either expressed or implied, as to
  86.   the quality or performance of this program, except that it will occupy
  87.   disk space.
  88.  
  89. * You may not make any changes or modifications to the program and you may
  90.   not de-compile, disassemble, or otherwise reverse-engineer it.  You may
  91.   not rent or lease it to others.
  92.  
  93. * The author will not be held liable to you or anyone for any direct,
  94.   indirect, incidental, consequential or other similar damages, including
  95.   any lost profits, lost savings which may result from the use or inability
  96.   to use this program.  Your use of the program constitutes your agreement
  97.   to this disclaimer and your release of the author from any form of
  98.   liability or litigation.
  99.  
  100. * I grant you a limited license to use QBBS2DAY and encourage you to copy
  101.   and distribute it in an unmodified way as much as you want, as long as
  102.   you still abide to the conditions mentioned here and no money or other
  103.   compensation is asked or accepted.
  104.  
  105.  
  106.  
  107.  
  108.                          INSTALLATION & CONFIGURATION
  109.                          ────────────────────────────
  110.                             QuickBBS, Remote Access
  111.  
  112. * Put QBBS2DAY.EXE somewhere on your hard disk.
  113.  
  114. * Enter your info and wishes in the control file QBBS2DAY.CTL.  You won't
  115.   have much trouble with this.  Make sure that QBBS2DAY can find that file
  116.   in the current directory when it is started.
  117.  
  118. * Put QBBS2DAY in your batch file to run it in your daily event or after
  119.   each user.  Keep in mind that you have to start QBBS2DAY from the path
  120.   where QuickBBS system files are placed to ensure QBBS2DAY finds
  121.   QuickBBS's CONFIG.BBS and TIMELOG.BBS (RA users have to start QBBS2DAY
  122.   in RA's system path).
  123.  
  124. * Now you have to change the option in your menu for the system usage graph,
  125.   from menu type 10 to 45 (or 5), and too place the following on the
  126.   optional data-line: QDAY
  127.  
  128. * Registered users can also show their bbs-users a system usage graph
  129.   of the FrontDoor/Binkley activity.  To do so you just have to place a
  130.   additional line in your menu with type 45 (or 5) and a data-line
  131.   saying: QDAYMAIL
  132.  
  133.  
  134.   QBBS2DAY will create the reports in your text files path (which is
  135. obtained from the CONFIG file).  QBBS2DAY will put a Ctrl-L (Screen
  136. Clearing Codes) in the beginning of the file.  You can display these
  137. files to your users by using QuickBBS (RA) TYPE 5 or TYPE 45
  138. ("Press [ENTER] to continue:" ) commands.
  139.  
  140.   QBBS2DAY  will create two files named QDAY.ASC and QDAY.ANS.  A file
  141. called QBBS2DAY.DAT will be created by enabling FrontDoor/Binkley activity.
  142. This file stores all information needed to process a FrontDoor/Binkley
  143. activity chart.
  144.  
  145.   It must be started everytime a user log's on (or off)  so the system-
  146. usage-graph will be up too date.  You may also run QBBS2DAY in a event if
  147. you like, but then the system-usage-graph will not be so up too date as
  148. running QBBS2DAY everytime a user logs on (or off).  Watch out, running
  149. QBBS2DAY when a user logs ON will cause him/her to wait a while.
  150. I suggest running QBBS2DAY after a user logs off and everytime a mailer
  151. called if FrontDoor/Binkley activity is enabled.
  152.  
  153.  
  154.                          INSTALLATION & CONFIGURATION
  155.                          ────────────────────────────
  156.                                     OPUS
  157.  
  158. * Put QBBS2DAY.EXE somewhere on your hard disk.
  159.  
  160. * Enter your info and wishes in the control file QBBS2DAY.CTL.  You won't
  161.   have much trouble with this.  Make sure that QBBS2DAY can find that file
  162.   in the current directory when it is started.
  163.  
  164. * Put QBBS2DAY in your batch file to run it in your daily event or after
  165.   each user.  QBBS2DAY generates a file called QBBS2DAY.OPS, all activity
  166.   of OPUS will be stored in this file (at this time these data will be
  167.   taken out of Binkleys logfile, but has to be defined seperately).
  168.  
  169. * You can display these files to your users by using its typical
  170.   OPUS command "<CTRL-O>SQDAY".
  171.  
  172. * Registered users can also show their bbs-users a system usage graph
  173.   of the FrontDoor/Binkley activity.  To do so you just have to place a
  174.   additional line in your file saying: <CTRL-O>SQDAYMAIL
  175.  
  176.  
  177.   QBBS2DAY will create the reports in your text files path (which is obtained
  178. from the CONFIG file).  QBBS2DAY will put a Ctrl-L (Screen Clearing Codes) in
  179. the beginning of the file.
  180.  
  181.   QBBS2DAY  will create two files named QDAY.BBS and QDAY.GBS.  A file
  182. called QBBS2DAY.DAT will be created by enabling FrontDoor/Binkley activity.
  183. This file stores all information needed to process a FrontDoor/Binkley
  184. activity chart.
  185.  
  186.   It must be started everytime a user log's on (or off)  so the system-
  187. usage-graph will be up too date.  You may also run QBBS2DAY in a event if
  188. you like, but then the system-usage-graph will not be so up too date as
  189. running QBBS2DAY everytime a user logs on (or off).  Watch out, running
  190. QBBS2DAY when a user logs ON will cause him/her to wait a while.
  191. I suggest running QBBS2DAY after a user logs off and everytime a mailer
  192. called if FrontDoor/Binkley activity is enabled.
  193.  
  194. Note:
  195.   QBBS2DAY reads all lines starting with # and *.
  196.   The exact online-time is calculated from two lines in your log-file:
  197.     # dd mmm hh:mm:ss BINK Connect .....   / start of session
  198.     line w/o OPUS after dd mmm hh:mm:ss    / end of session
  199.  
  200.   You can change these lines by inserting the follwing code into the
  201.   configuration file:
  202.  
  203.     OPUS-START char          <- Default-char: #
  204.     OPUS-STARTTEXT text      <- Default-text: BINK Connect
  205.  
  206.     OPUS-ENDTEXT text        <- Default-text: OPUS
  207.  
  208.   Note: If you have another date/time format please contact me, so
  209.   i can change my program to fit to your logfile-format.
  210.  
  211.  
  212.  
  213.  
  214.                          CONFIGURATION FILE
  215.                          ──────────────────
  216.  
  217.   You'll have to create a file named QBBS2DAY.CTL if you want one or more
  218. of the following things:
  219.  
  220.   * define your BBS-system (QuickBBS, RAccess, OPUS)
  221.   * different colors (ANSI)
  222.   * defineable character (registration requiered)
  223.   * IBM-ASCII (8-bit ascii-characters)
  224.   * IBM-ANSI  (8-bit ascii-characters)
  225.   * own messages (native language, etc.)
  226.   * Mailer activity included (FrontDoor, Binkley, D'Bridge)
  227.  
  228.   You can place any of these commands into QBBS2DAY.CTL:
  229.  
  230.   Mandatory:
  231.     BBSSYSTEM system        <- define BBS system  (RA, QBBS or OPUS)
  232.     TEXTPATH path           <- path, where to place the ASC/ANS (BBS/GBS) files
  233.                                this command must be used with OPUS and can be
  234.                                used with QBBS/RA if you don't want QBBS2DAY too
  235.                                use the data in the BBS-configurationfile. If no
  236.                                BBS-configurationfile is found and no TEXTPATH
  237.                                added to QBBS2DAY.CTL the execution of this
  238.                                programm is aborted.
  239.   Optional:
  240.     HIGH ansi-code          <- title color
  241.     NORM ansi-code          <- border colors
  242.     MAILER ansi-code        <- chart colors for mailers
  243.     CALLER ansi-code        <- chart colors for human callers
  244.     HEADER text ^F text     <- define own header          (max. 79 characters)
  245.     AVG text                <- define average text         (max. 4 characters)
  246.     DEFINE text             <- enable definition text     (max. 70 characters)
  247.                                (explaination about mailer, caller)
  248.     IBM-DEFINE text         <- enable definition text ibm-charset
  249.                                (explaination about mailer, caller)
  250.     IBM-ASCII               <- enable IBM-ASCII codes in ASCII file
  251.     IBM-ANSI                <- enable IBM-ASCII codes in ANSI file
  252.  
  253.   Opus:
  254.     OPUS-COMMAND text       <- enable execution of OPUS-command at end of
  255.                                BBS/GBS files (OPUS only)
  256.     OPUS-LOGPATH path       <- path and name of OPUS logfile
  257.  
  258.   Mailer:
  259.     MAIL                    <- include Mailer activity
  260.     MAILERSYSTEM system     <- define mailer, FrontDoor (F), Binkley (B) or
  261.                                D'Bridge (D)
  262.     MAILLOG path            <- path and name of mailer-logfile
  263.     MAILHEADER text ^F text <- define own header for mailer-activity chart
  264.  
  265.  
  266.   Notes: ansi-code  == textstring with ansi codes, up to 10 characters
  267.                        It's a good idea to have the same backgroundcolors
  268.                        for mailer and caller.
  269.          text       == string with ascii characters and NO ansi-codes.
  270.                        ^F will represent the number of days which are
  271.                        included in the activity chart.
  272.  
  273.  
  274.  
  275.                   CONFIGURATION FILE (Registered QBBS2DAY)
  276.                   ────────────────────────────────────────
  277.  
  278.   You can add these following lines to the configuration file:
  279.  
  280.   Mailer:
  281.     MAILCHART                <- create extra chart for Mailer Activity
  282.                                 these files will be called QDAYMAIL.ANS/ASC
  283.  
  284.     MAILCHAR                 <- let's QBBS2DAY use callers-characters in
  285.                                 QDAYMAIL ansi file.
  286.  
  287.   IBM-characters:
  288.     IBM-CharCLo char    (▄)  <- define caller half size
  289.     IBM-CharCHi char    (█)  <- define caller full size
  290.     IBM-CharCALo char   (▄)  <- define caller half size middle avg.
  291.     IBM-CharCAHi char   (█)  <- define caller full size middle avg.
  292.     IBM-CharMLo char    (╥)  <- define mailer half size
  293.     IBM-CharMHi char    (║)  <- define mailer full size
  294.     IBM-CharMALo char   (╥)  <- define mailer half size middle avg.
  295.     IBM-CharMAHi char   (╫)  <- define mailer full size middle avg.
  296.     IBM-CharAVG char    (»)  <- define middle average sign
  297.     IBM-CharMDL char    (─)  <- define middle average (line)
  298.  
  299.   Standard-ASCII-characters:
  300.     ASC-CharCLo char    (c)  <- Define caller half size
  301.     ASC-CharCHi char    (C)  <- define caller full size
  302.     ASC-CharMLo char    (m)  <- define Mailer half size
  303.     ASC-CharMHi char    (M)  <- define mailer full size
  304.     ASC-CharAVG char    (>)  <- define middle average sign
  305.     ASC-CharMDL char    (-)  <- define middle average (line)
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.                     CONFIGURATION  -  FrontDoor
  313.                     ───────────────────────────
  314. FrontDoor:
  315.  
  316.   If you're including FrontDoor activity please have the following
  317. four lines:
  318.  
  319.    " * Sent/Rcvd files "
  320.    " ~ Session information "
  321.    " - Trivial messages "
  322.    " + Brief messages "
  323.  
  324. set to   Y E S   in FrontDoor-Setup Mailer / Miscellaneous / Log.
  325.  
  326.  
  327.  
  328.                     CONFIGURATION  -  Binkley
  329.                     ─────────────────────────
  330. Binkley:
  331.  
  332.   QBBS2DAY reads all lines starting with # and *.
  333.   The exact online-time is calculated from two lines in your log-file:
  334.     # dd mmm hh:mm:ss BINK Connect .....   / start of session
  335.     * dd mmm hh:mm:ss BINK End ......      / end of session
  336.  
  337.   You can change these lines by inserting the follwing code into the
  338.   configuration file:
  339.  
  340.     BINK-START char          <- Default-char: #
  341.     BINK-STARTTEXT text      <- Default-text: BINK Connect
  342.  
  343.     BINK-END char            <- Default-char: *
  344.     BINK-ENDTEXT text        <- Default-text: BINK End
  345.  
  346.   Note: If you have another date/time format please contact me, so
  347.   i can change my program to fit to your logfile-format.
  348.  
  349.  
  350.  
  351.                     CONFIGURATION  -  D'Bridge
  352.                     ──────────────────────────
  353. D'Bridge:
  354.  
  355.   The online-time is calculated from these lines in your log-file:
  356.     mm/dd/yy hh:mm  EMSI: .....                     / start of session
  357.     mm/dd/yy hh:mm  YOOHOO: .....                   / start of session
  358.     mm/dd/yy hh:mm  Mail sent successfully ......   / end of session
  359.     mm/dd/yy hh:mm  One connection ......           / end of session
  360.     mm/dd/yy hh:mm  Bad/incomplete archive ......   / end of session
  361.  
  362.   You can change these lines by inserting the following code into the
  363.   configuration file:
  364.  
  365.     DB-STARTTEXT text        <- Default-text: EMSI:
  366.     DB-STARTTEXT1 text       <- Default-text: YOOHOO:
  367.  
  368.     DB-ENDTEXT text          <- Default-text: SESSION SUCCESSFUL
  369.     DB-ENDTEXT2 text         <- Default-text: ONE PACKET
  370.     DB-ENDTEXT3 text         <- Default-text: BAD/INCOMPLETE ARCHIVE
  371.  
  372.  
  373.  
  374.  
  375.              CONFIGURATION  -  D'Bridge 1.31 and higher
  376.              ──────────────────────────────────────────
  377. D'Bridge:
  378.  
  379.   The online-time should be calculated from these lines in your log-file:
  380.     mm/dd/yy hh:mm  EMSI: .....                     / start of session
  381.     mm/dd/yy hh:mm  YOOHOO: .....                   / start of session
  382.     mm/dd/yy hh:mm  Inbound session complete ...... / end of session
  383.     mm/dd/yy hh:mm  Estimation ......               / end of session
  384.     mm/dd/yy hh:mm  Session failure ......          / end of session
  385.  
  386.   You can change these lines by inserting the following code into the
  387.   configuration file:
  388.  
  389.     DB-STARTTEXT text        <- Default-text: EMSI:
  390.     DB-STARTTEXT1 text       <- Default-text: YOOHOO:
  391.  
  392.     DB-ENDTEXT text          <- Recommended: INBOUND SESSION COMPLETE
  393.     DB-ENDTEXT2 text         <- Recommended: ESTIMATION
  394.     DB-ENDTEXT3 text         <- Recommended: SESSION FAILURE
  395.  
  396.   Note: If you have another date/time format please contact me, so
  397.   i can change my program to fit to your logfile-format.
  398.  
  399.  
  400.  
  401.                                 RELEASES
  402.                                 ────────
  403.   v1.00  full release
  404.            QuickBBS chart generated as a copy of QBS
  405.   v2.00  full release
  406.            QuickBBS,RA and FrontDoor are supported, seperate chart for
  407.            registered user implemented.
  408.   v2.10  full release
  409.            BINKLEY is supported. Changes all Mailernames from FD to MAIL
  410.            OPUS is supported (beta-test).  QuickBBS / RA configurationfile
  411.            can be ignored by adding TEXTPATH to controlfile.
  412.            bug in day-lap fixed, no more 1440minutes if mailer logged in
  413.            at 23.00hrs and leaves at 0.00hrs.
  414.   v2.11  beta-test
  415.            bug in daycount fixed, so Timelog.BBS may be older than a year.
  416.   v2.12  beta-test
  417.            implemented D'Bridge v1.18 mailer-activity.
  418.   v2.13  beta-test
  419.            appended ANSI-reset-command to end of chart. (ESC [0m)
  420.            implemented D'Bridge v1.30 mailer-activity.
  421.   v2.20  full release
  422.            update to D'Bridge v1.31, 2 START and 3 END commands
  423.            are recognized. QBBS2DAY tested with LZEXE and NO problems
  424.            were found.
  425.  
  426.  
  427.  
  428.                                 HISTORY / FUTURE:
  429.                                 ─────────────────
  430.  
  431.   Until now I spent hours thinking, writing, converting, debugging and
  432. documenting QBBS2DAY, and I will keep on doing that.  QBBS2DAY is a little
  433. bit crippled: if you don't register, it will not display a extra file
  434. showing FrontDoor/Binkley's Mailer-activity (QDAYMAIL.A??).  If you use this
  435. program for a period of time and you decide you like it, you can get a
  436. registration *)  key by sending the EXACT TEXT you want QBBS2DAY registered
  437. too and which version you are currently using, along with any questions,
  438. comments, suggestions and bug-reports, and of course your (net) mail address,
  439. to:
  440.             Robert Hermans
  441.             Hoosveld 35
  442.             NL - 6075 DC Herkenbosch
  443.             The Netherlands
  444.  
  445.   If you run into any bugs or problems you cannot solve, I can be reached
  446. either through my BBS, too:
  447.  
  448.             DC SKYline
  449.             (FidoNet 2:512/102)
  450.             INTL-31-4752-5306
  451.             (V.21,  V.22,  V.22bis,  V.32,  HST 14400)
  452.  
  453.  
  454. *)                              REGISTRATION
  455.                                 ────────────
  456.  
  457.   There are two ways of registration :
  458.  
  459.   1.) By using QBBS2DAY on a regulary basis you MUST SEND a POSTCARD to my
  460. home address (shown above).  All I ask is to be able to show your postcard
  461. to my grandchildren and say "Look at this one Becky - here's another nice
  462. postcard from a guy at Lake Powell, Arizona".
  463.  
  464.   2.) A contribution of at least US$ 10.00, sent to the above address, would
  465. be greatly appreciated.  Dutch residents may send guildes instead.
  466.  
  467.   Note: If you're using money-registration you'll receive your key thru
  468. netmail, if your nodenumber is present, otherwise you'll have to poll
  469. DC SKYline (2:512/102) to get the desired key.  If you're using
  470. Postcard-registration you allways have to poll to receive your key.
  471. Please allow up to 21 days too process due to Post-transportation speed.
  472.  
  473.  
  474.  
  475.                  OFFICIAL QBBS2DAY BETA & DISTRIBUTION SITES:
  476.                  ────────────────────────────────────────────
  477.  
  478.   Node        Sysop              BBS Name         Phone
  479.   ══════════════════════════════════════════════════════════════════════
  480.   2:512/102   Robert Hermans     DC SKYline       31-4752-5306  V32, HST
  481.   2:242/5     Uwe Muckel         Mail-Power       49-2456-3723  HST
  482.  
  483.   You can always request the latest version here, using alias "QBBS2DAY".
  484. I would like to thank my beta testers/support nodes for their help with this
  485. and many other projects.  I couldn't have done it without them!
  486.  
  487.  
  488.